Skip to main content

ARInput

Members

This class is obtained through ARCursor.UserInput and provides information about the user's input.


Gamepad

A dictionary of Enum.UserInputType.GamepadX keys to an array of InputObjects representing the current state of all available inputs for said gamepad as values.


[Enum.UserInputType]

It is an array whose values are of the type InputObject.


GamepadEnabled

This property describes whether the device being used by a user has an available gamepad. If gamepads are available. It is of the type boolean.


Keyboard

An array of InputObjects associated with the keys currently being pressed. It is an array whose values are of the type InputObject.


KeyboardEnabled

This property describes whether the user's device has a keyboard available. This property is true when the user's device has an available keyboard, and false when it does not. It is of the type boolean.


LastInputType

The Enum.UserInputType associated with the user's most recent input. It is of the type Enum.UserInputType.


Mouse

An array of InputObjects corresponding to the mouse buttons currently being currently held down. It is an array whose values are of the type InputObject.


TouchEnabled

This property describes whether the user's current device has a touch screen available. It is of the type boolean.


VREnabled

This property describes whether the user is using a virtual reality (VR) device. It is of the type boolean.

Luau Type

This is the luau type for ARInput. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

type ARInput = {
Keyboard: { InputObject },
VREnabled: boolean,
Mouse: { InputObject },
GamepadEnabled: boolean,
LastInputType: Enum.UserInputType,
Gamepad: {
[Enum.UserInputType]: { InputObject },
},
KeyboardEnabled: boolean,
TouchEnabled: boolean,
}